getmac
Get the mac address of the current machine you are on
Will run anywhere that the underlying commands are present:
-
On Windows, getmac is used
-
On Unix/Linux/Mac, ifconfig is used if present, otherwise ip is used
-
Other environments are not supported as they provide no way of fetching the mac address.
That means:
-
If you are building a server app, or a desktop app, and wanting to get the mac address of where the node.js process is run, then this will work as expected.
-
If you are building a server app, this will only get the mac address of the server. There is no way to get a web browser user's mac address without installing software on their computer.
-
If you are building an electron app, you can run this on the server-side then communicate it to the client side.
-
This library will not run in web browsers / on the client-side / in webpack / in browserify / in angular / in react / in jQuery / in HTML. It will only run on node.js environments, which the web browser is not.
Install
Install Globally
- Install:
npm install --global getmac
- Executable:
getmac-node
Install Locally
- Install:
npm install --save getmac
- Executable:
npx getmac-node
- Require:
require('getmac')
This package is published with the following editions:
getmac
aliases getmac/index.js
which uses Editions to automatically select the correct edition for the consumers environmentgetmac/source/index.coffee
is coffeescript source code with require for modulesgetmac/edition-esnext/index.js
is coffeescript compiled for node.js with require for modulesgetmac/edition-node-0.10/index.js
is coffeescript compiled for node.js 0.10 with require for modules
Usage
CLI
Install globally npm install -g getmac
, then run with getmac-node
API
Install locally npm install --save getmac
, then use like so:
require('getmac').getMac(function(err, macAddress){
if (err) throw err
console.log(macAddress)
})
require('getmac').getMac({iface: 'eth0'}, function(err, macAddress){
if (err) throw err
console.log(macAddress)
})
if ( require('getmac').isMac("e4:ce:8f:5b:a7:fc") ) {
console.log('valid mac')
}
else {
console.log('invalid mac')
}
History
Discover the release history by heading on over to the HISTORY.md
file.
Contribute
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Backers
Maintainers
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
License
Unless stated otherwise all works are:
and licensed under: